Skip to content


ardupilot  None  ros2  dds  micro ros  xrce  lua  sitl  scripts  plugin  gazebo  garden  SITL  debug  rangefinder  pymavlink  mavros  distance sensor  system_time  timesync  ardurover  script  cheat sheet  mavlink  wireshark  mavproxy  mission planner  cmake  gtest  ctest  101  cpp  c++  format  fmt  smart pointers  multithreading  spdlog  cyclonedds  eprosima  fastdds  aptly  apt  repository  repo  local  mirror  encryption  pgp  docker  arm  qemu  python  vscode  devcontainer  container  state  networking  network  nvidia  app  gui  tutorial  tips  volume  mount  compose  multi-stage  stage  docker compose  microsoft  dotnet  .net  c#  git  bundle  backup  submodules  github  hooks  pre-commit  marpit  presentation  marp  markdown  mermaid  mkdocs  video  ffmpeg  gstreamer  cheat-sheet  sdp  opencv  appsrc  appsink  acceleration  va-api  intel  v4l2loopback  pipe  compositor  alpha  shmsink  shmsrc  intersink  intersrc  tee  queue  udp  stream  gst  binding  gi  kml  geo  gis  spatial  gdal  ogr  raster  vector  qgc  qgroundcontrol  snippets  cheat Sheet  asyncio  event  future  thread  task  can  canbus  click  cli  cupy  numpy  gpu  dataclass  slots  dev container  fastapi  rest  uvicorn  deb  debian  package  setup  stdeb  project  jupyter  widgets  interactive  plot  matplotlib  ipywidgets  3d  subplot  open3d  point cloud  packaging  pyproject  pipx  package manager  template  black  isort  templates  cookiecutter  docs  project document  docstrings  flake8  linter  git-hook  mypy  unittest  pytest  pylint  from a-z  fixture  scope  logging  pytest.ini  mock  parameterize  enum  flag  iterator  generator  yaml  yml  logging config  tuple  namedtuple  typing  annotation  generic  literal  protocol  self  typed dict  typevar  pyzmq  zmq  msgpack  slam  cartographer  slam_toolbox  build system  colcon  action  namespace  remap  control2  demo  diff-drive  ignition  ros2_control  effort  velocity  gdb  mix  multi language  qos  tag  plugins  ros  pub  sub  msg  node  time  zero-copy  shm  loan message  rmw  image  large message  discovery  zenoh  bridge  zenoh-plugin-ros2dds  algorithm  calibration  diff  pid  dev  colcon_cd  clean  custom  bloom  settings  behavior  py_trees  bt  behavior_trees  blackboard  visualization  debugging  diagnostic  DiagnosticTask  diagnostics  tutorials  math  apm  rat_runtime_monitor  bag  rosbag  rosbags  tools  smach  state machine  yasmin  web  rosbridge  vue  profile  gazebo-classic  launch  spawn  model  cook  camera  sensors  gps  imu  ray  gazebo_ros_ray_sensor  lidar  ultrsonic  range  ultrasonic  gazebo classic  wrench  gazebo_ros_state  gz  sdf  world  vscode tips  gazebogz-sim-joint-position-controller-system  simulation  ros_gz_bridge  ign  xacro  diff_drive  odom  odometry  joint_state  argument  OpaqueFunction  DeclareLaunchArgument  LaunchConfiguration  tmux  tmuxp  nav  nav2  turtlebot  perception  cv_bridge  test  rclpy  goal abort  cancel goal  action client  action server  custom messages  executor  MultiThreadedExecutor  SingleThreadedExecutor  lifecycle  parameter  param  dynamic-reconfigure  get  global server  persist_parameter  service  client  setup.py  package.xml  parameters  msgs  executers  rqt  rviz  rviz2  pose  marker  tf2  local_setup  rosdep  project settings  vcstool  urdf  robot_state_publisher  urdf_to_graphiz  joint  link  robotics  path planning  trajectory  speed  filters  control  kalman_filter  kalman  filter  pcl  code  extensions  remote  ssh  json  schema  deep learning  ai  beginner  regression  reinforcement learning  q learning  gym  gymnasium  deepsort  onnx  inference  build  source  wheel  cuda  vision  siam-mask  tracking  segmentation  yolo  ultralytics  yolov8  jetson  tensorrt  rest api  js  javascript  async  cross-compiler  esp32  nano  i2c  adafruit  arduino  sensor  mb1202  uart  serial  tfmini  gpio  embedded  rpi  raspberry pi  arducam  teensy  microros  udev  rule  usb  micro python  pymakr  config  material  workshope  texture  joints  loop device  rootfs  zah  linux  rm  ubuntu  sudo  sudoers  nopasswd  visudo  shell  key  gpg  sign  commands  update-alternative  dpkg  debconf  ip  ss  netstat  snap  deploy  systemd  socat  tc  mtu  select  yocto  poky  projects  courses to follow  matrix  graphics  rotation  2d  course  drone  quad  uav  geometric control  se3  so3  joint_states  JointState  Header  vrx  buoyancy 

ROS2 Params basic example#

Simple node with params, run the node from cli and launch file, control the parameters from cli or yaml file

node#

import rclpy
from rclpy.node import Node

class BasicParams(Node):
    def __init__(self):
        super().__init__('basic_param')
        self.get_logger().info("start basic param")
        self.declare_parameter('my_str', value="string data")
        self.declare_parameter('my_int', value=10)

        self.my_str = self.get_parameter("my_str").value
        self.my_int = self.get_parameter("my_int").value

        self.get_logger().info(f"my_str: {self.my_str}")
        self.get_logger().info(f"my_int: {self.my_int}")


def main(args=None):
    rclpy.init(args=args)
    node = BasicParams()
    rclpy.spin(node)
    node.destroy_node()
    rclpy.shutdown()

if __name__ == "__main__":
    main()

usage#

cli#

use default#

simple run
ros2 run pkg_python_tutorial param_basic 
[INFO] [1674810902.438001696] [basic_param]: start basic param
[INFO] [1674810902.438464027] [basic_param]: my_str: string data
[INFO] [1674810902.438649552] [basic_param]: my_int: 10

init from cli#

init from params from cli
ros2 run pkg_python_tutorial param_basic --ros-args -p my_int:=20 -p my_str:="hello world"
[INFO] [1674811321.921565297] [basic_param]: start basic param
[INFO] [1674811321.921986535] [basic_param]: my_str: hello world
[INFO] [1674811321.922149889] [basic_param]: my_int: 20

load from yaml file#

param file structure
<node name>:
    ros__parameters:
        <param_name>: <param_value>
basic.yaml
basic_param:
  ros__parameters:
    my_int: 100
    my_str: hello yaml

Tip

Add copy instruction to data_files section

data_files=[
    (os.path.join('share', package_name, "config"), glob('config/*.yaml'))
]
init from yaml file
ros2 run pkg_python_tutorial param_basic --ros-args  --params-file  config/basic.yaml
mix yaml and param
# the last setting 
ros2 run pkg_python_tutorial param_basic --ros-args  --params-file  config/basic.yaml -p my_int:=10

# if the param cli set the value after the param yaml file , the value from the parameter is set
# if the param is set before the yaml file, the value from the yaml file is set

launch#

set param in launch file#

node_with_param.launch.py
from launch import LaunchDescription
from launch_ros.actions import Node

def generate_launch_description():
    ld = LaunchDescription()

    sim_node =  Node(
            package='pkg_python_tutorial',
            namespace='',
            executable='param_basic',
            name='basic',
            parameters=[
                {
                    "my_str": "data from launch",
                    "my_int": 100
                }
            ]
        )
    ld.add_action(sim_node)
    return ld

load param from yaml in launch file#

node_with_param_file.launch.py
import os
from launch import LaunchDescription
from ament_index_python.packages import get_package_share_directory
from launch_ros.actions import Node

def generate_launch_description():
    ld = LaunchDescription()

    config = os.path.join(
        get_package_share_directory('pkg_python_tutorial'),
        'config',
        'params.yaml'
        )

    sim_node =  Node(
            package='pkg_python_tutorial',
            namespace='',
            executable='param_basic',
            name='basic',
            parameters=[config]
        )
    ld.add_action(sim_node)
    return ld
params.yaml
basic:
  ros__parameters:
    my_str: "launch and load from yaml"
    my_int: 100

node /yaml name

The node name in yaml file need to be the same name we set in the launch file Node.name property

load param from yaml with override by local launch params#

```python title=”” linenums=”1” hl_lines=”6,8,9” sim_node = Node( package=’simples’, namespace=’‘, executable=’param_basic’, name=’basic_param’, parameters=[config, { “my_str”: “override”, “my_int”: 1 }
] )

---

### rqt

```bash
ros2 run rqt_reconfigure rqt_reconfigure
# or
# run rqt_gui and load th dynamic_reconfiguration plugin